Skip to content

Creating a new Organization

Request

Creates an organization.

Bulk Create

This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "organizations": [
    {
      "name": "Organization",
      "parent_id": 123
    },
    {
      "name": "Organization",
      "parent_id": 123
    }
  ]
}

This endpoint returns structured Organization objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the organizations top-level JSON key. Please see our Response Format section for more information.

Bodyapplication/jsonrequired
organizationobject
{
  "organization": {
    "name": "string",
    "parent_id": 0
  }
}

Responses

Organization has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
organizationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "organizations": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}